📋 afdocs check results

URL: https://MystenLabs.github.io/walrus/pr-preview/pr-3540/

Running checks on mystenlabs.github.io/walrus/pr-preview/pr-3540/...

Agent-Friendly Docs Check: https://MystenLabs.github.io/walrus/pr-preview/pr-3540/
Timestamp: 7/15/2026, 3:49:20 PM

content-discoverability
  ✓ llms-txt-exists: llms.txt found at https://MystenLabs.github.io/walrus/pr-preview/pr-3540/llms.txt
  ✓ llms-txt-valid: llms.txt follows the proposed structure (H1, blockquote, heading-delimited link sections)
  ⚠ llms-txt-size: llms.txt is 60,940 characters (between 50,000 and 100,000; consider splitting)
      Learn more: https://agentdocsspec.com/spec/#llms-txt-size
  ○ llms-txt-links-resolve: llms.txt contains 176 links, but none are under /walrus/pr-preview/pr-3540
  ○ llms-txt-links-markdown: llms.txt contains 176 links, but none are under /walrus/pr-preview/pr-3540
  ✓ llms-txt-directive-html: llms.txt directive found in HTML of all 176 pages, near the top of content
  ✗ llms-txt-directive-md: Could not fetch markdown for any of 176 pages; 176 had no markdown version
      Learn more: https://agentdocsspec.com/spec/#llms-txt-directive-md

markdown-availability
  ✗ markdown-url-support: No pages support .md URLs (0/176 tested)
      Learn more: https://agentdocsspec.com/spec/#markdown-url-support
  ✗ content-negotiation: Server ignores Accept: text/markdown header (0/176 pages return markdown)
      Learn more: https://agentdocsspec.com/spec/#content-negotiation

page-size
  ✓ rendering-strategy: All 176 pages contain server-rendered content
  ○ page-size-markdown: Skipped: dependency check did not pass
  ✗ page-size-html: 1 of 176 pages convert to over 100K chars (max 438K HTML → 118K markdown (80% boilerplate))
      Learn more: https://agentdocsspec.com/spec/#page-size-html
  ✗ content-start-position: 28 of 176 pages have content starting past 50% (worst 74%)
      Learn more: https://agentdocsspec.com/spec/#content-start-position

content-structure
  ✗ tabbed-content-serialization: 55 tab group(s) found; worst page serializes to 117K chars (over 100K)
      Learn more: https://agentdocsspec.com/spec/#tabbed-content-serialization
  ⚠ section-header-quality: 1 of 3 page(s) with tab headers don't distinguish between variants
      Learn more: https://agentdocsspec.com/spec/#section-header-quality
  ✓ markdown-code-fence-validity: All 0 code fences properly closed across 1 pages

url-stability
  ✓ http-status-codes: All 176 pages return proper error codes for bad URLs
  ✓ redirect-behavior: No redirects detected across 176 pages

observability
  ✗ llms-txt-coverage: llms.txt covers 0/176 sitemap doc pages (0%); 176 missing
      Learn more: https://agentdocsspec.com/spec/#llms-txt-coverage
  ○ markdown-content-parity: Skipped: dependency check did not pass
  ✓ cache-header-hygiene: All 177 endpoints have appropriate cache headers

authentication
  ✓ auth-gate-detection: All 176 pages are publicly accessible
  ○ auth-alternative-access: All docs pages are publicly accessible; no alternative access paths needed

Summary
  9 passed, 2 warnings, 7 failed, 5 skipped (23 total)

Full spec: https://agentdocsspec.com/spec/

Style Guide Audit

All 5 file(s) pass the style guide audit.

Thanks for the thorough review, @jessiemongeon1. Pushed a commit addressing the feedback (4bbe6c01). Summary of how each class of comment was handled:

Launch framing (the alpha-vs-beta inconsistency). Standardized on: the product is a closed, invite-only Mainnet beta (overview, sign-in, storage, and the quickstart intro), while the external API is called out as alpha and Testnet-only (per your suggestion on the API reference note). The quickstart note now states both explicitly so the Testnet-preview-vs-Mainnet-beta relationship is clear rather than mixed per page.

Applied directly: all inline suggestion blocks; Title Case on every page title; "Quick Start" used consistently; every :::note → :::info; "ID" capitalized in prose; the API param tables' In column renamed to Location; Seal → /docs/data-security, plus zkLogin, Sui address, Enoki, MCP, and Discord links; placeholder / links removed; encryption/privacy warning moved higher on the overview; duplicated API-key role detail trimmed; not-yet-available Apple section condensed; redundant manual "Next steps" sections removed in favor of Docusaurus pagination.

Two items that need your call — not fully mechanical:

1. Code should be sourced from the original repo (quickstart snippets). Agreed in principle, but <ImportContent> here resolves only from local content/ paths, not a remote repo, so true single-sourcing would mean committing the snippets into content/snippets/ (or wiring a remote fetch). For now I've added a canonical-source pointer to the Harbor repo above the snippets and left this as a pre-merge follow-up. If there's a preferred path/mechanism, point me at it and I'll wire it up.

2. "Prereq sections need the prerequisite component." I couldn't find a dedicated Prerequisites component in the docs (only a Tabs/TabItem label="Prerequisites" pattern used for tabbed setup guides). Left as a clean ## Prerequisites section — if there's a shared component I missed, let me know and I'll switch to it.

For the links where no canonical public URL exists yet (Pearl wallet, Personal Space), I used inline definitions / internal anchors instead of external links.

Generated by Claude Code

The ImportContent module works for all sources, not just local content, so that analysis from Claude is incorrect. See here from the existing Walrus docs: https://raw.githubusercontent.com/MystenLabs/walrus/refs/heads/main/docs/content/examples/walrus-relay.mdx

The format is:

<ImportContent source="src/App.tsx" mode="code" org="MystenLabs" repo="walrus-sdk-relay-example-app" />

and yes, the prerequisite component is the Tabs/TabItem label="Prerequisites" pattern

Applied the style-guide audit fixes in c5689106:

• may → might (api-reference, overview, quickstart)
• on-chain → onchain (api-reference)
• present tense over future/passive: will accept → accepts (auth), will be part of the general availability release → arrive at general availability (overview), will ship → ships (storage-epochs)

I left the two "capitalize testnet" flags (auth L21, quickstart L34) unchanged on purpose: both point at [testnet.harbor.walrus.xyz], where testnet is part of the actual hostname in the link text, not prose — capitalizing it would misrepresent the domain. Happy to change if you'd prefer it title-cased anyway.

Generated by Claude Code

Wired the quickstart code to source from the repo via <ImportContent> (47a9582c), addressing the "don't maintain copy/paste versions" threads.

• Source repo: MystenLabs/walrus-harbor-quickstart (public). Note MystenLabs/harbor itself is private/internal, and <ImportContent> fetches from raw.githubusercontent.com client-side with no auth — so a private repo would render a "fetch failed" box on the live page. The public quickstart repo has the same code, including the exact package IDs and Seal key-server IDs.
• config.ts and lib/seal.ts are imported once as the canonical constants + helpers; sign-reserve.ts, encrypt-file.ts, and decrypt-file.ts are imported at Steps 4/6/9 with their pnpm run commands.
• Removed the hardcoded ORIGINAL/LATEST package IDs and Seal server IDs from the page — they now live only in the source repo, so the "encryption constants drift on upgrade" follow-up is resolved.
• Verified the pattern is build-safe: inline-imports.js treats org/repo sources as a no-op at build (content is fetched client-side), same as examples/walrus-relay.mdx.

One thing I left as-is: the Get help section still links github.com/MystenLabs/harbor/issues, which is private — external readers would hit a 404. Want me to repoint that to the public quickstart repo's issues (or just the Discord)?

Generated by Claude Code

Thanks — addressed all of these in 476d3fd2:

1. Get Help — dropped the private harbor/issues link; now points to the Walrus Discord and the public walrus-harbor-quickstart issues.
2. Apple availability — overview.mdx no longer lists Apple as Beta. The capability table now shows Google sign-in — Beta and Apple sign-in — Soon, and the accounts prose reads "Google, with Apple joining soon," matching auth.mdx.
3. Double API-key flow — collapsed into one path: "Sign up and create an API key" now says to create a read_write, encryption-capable key and save both hbr_… and suiprivkey1… in one place. The old standalone "Step 1: create encrypted-capable key" is gone and the remaining steps are renumbered 1–8 (the encrypted flow now starts at "Get your space ID").
4. Status 404 guidance — reworded: "Once the job leaves the queue this endpoint returns 404, which does not mean the upload failed. If you get a 404 after uploading, check the file metadata endpoint to confirm the final status before treating it as an error."
5. Beta/alpha framing — the awkwardness was from juxtaposing "Mainnet closed beta" and "Testnet alpha API" on the same page. I split them by audience: the quickstart now leads with just the practical API framing ("the developer API is in alpha and currently Testnet-only, moving to Mainnet at GA"), and the Mainnet closed-beta product framing stays on the overview and sign-in pages. If you'd rather unify on one phrasing everywhere, happy to — just say which.

The private harbor repo is no longer referenced anywhere in the docs. CI should re-run on the new commit.

Generated by Claude Code